home *** CD-ROM | disk | FTP | other *** search
/ PC-Blue - MS DOS Public Domain Library / PC-Blue MS-DOS Public Domain Library - NYACC.iso / vol197 / techref.oqt / techref.out
Encoding:
Text File  |  1986-11-25  |  14.6 KB  |  397 lines
  1.  
  2.                                    DBS-KAT (TM)
  3.  
  4.                             The Easy, Practical, Super
  5.                             Capacity Diskette Cataloger
  6.  
  7.  
  8.                             TECHNICAL REFERENCE MANUAL
  9.  
  10.  
  11.                                         by
  12.                                     R.H. Martin
  13.  
  14.  
  15.                               Applied Foresight Inc.
  16.                                   P.O. Box 20607
  17.                              Bloomington, Minn.  55420
  18.  
  19.                                  February 23, 1986
  20.                                     Version 1.3
  21.  
  22.  
  23.  
  24.                            Copyright 1986 by R.H. Martin
  25.                                 All Rights Reserved
  26.  
  27.  
  28.  
  29.                             A DB-SHARE Software Product
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                     A limited license is hereby granted to copy
  37.                   and distribute wholly unmodified copies of the
  38.                DBS-KAT Software Diskette which contains this manual
  39.  
  40.                      (Read the manual, "THE DB-SHARE PROGRAM"
  41.                    for full details about this limited license)
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.                                                              Trademark Pending
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.      DBS-KAT TECH REF MANUAL       Copyright 1986 R.H. Martin       P. 2
  69.  
  70.  
  71.  
  72.                                  TABLE OF CONTENTS
  73.  
  74.      Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  75.      About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  76.      Efficiency Of DBS-KAT. . . . . . . . . .. . . . . . . . . . . . . . . . 2
  77.      DBS-KAT Inquiry Search Strategies . . . . . . . . . . . . . . . . . . . 3
  78.      Recovering Your Database. . . . . . . . . . . . . . . . . . . . . . . . 4
  79.      DBS-KAT Version History . . . . . . . . . . . . . . . . . . . . . . . . 6
  80.  
  81.  
  82.                                  ABOUT THIS MANUAL
  83.  
  84.      With the exception of the Registration Benefits section, this manual
  85.      restricts itself to the base DBS-KAT software diskette.  The concept of
  86.      "base software" is discussed in greater detail in the THE DB-SHARE
  87.      PROGRAM manual.
  88.  
  89.      A section is designated by a centered and underlined heading.  Centered
  90.      but NOT underlined headings are referred to as a subsection.
  91.  
  92.  
  93.                                EFFICIENCY OF DBS-KAT
  94.  
  95.      DBS-KAT is fast and efficient, minimizing the amount of disk space
  96.      required to store the cataloged information.  Each date and time field is
  97.      concatenated together and stored as a 4 byte long integer.  In plain
  98.      words, what you see on the screen as 10 bytes of information is stored in
  99.      4 bytes of storage.  The four byte volume ID is stored as a 2 byte
  100.      integer.  If a diskette filename is associated with a floppy
  101.      subdirectory, the directory name is separately stored in the database
  102.      only once in its alphabetical description form, and given an ID number.
  103.      This ID number is carried in the appropriate individual filename records.
  104.  
  105.      The entire DBS-KAT database is kept in the files prefixed as KATDB.DA and
  106.      KATDB.KE.  The database contains the system control record, the diskette
  107.      volume text information and the directory file information for all
  108.      cataloged files.  In addition, all the record pointers are stored in the
  109.      database to allow quick updating and retrieval of information.   The file
  110.      KATDB.DBD is the data base structure dictionary which never grows but is
  111.      needed for the programs to work and must reside in the same directory
  112.      area on the hard disk alongside the other KATDB files.
  113.  
  114.      What this means is that although DBS-KAT must keep its inter-
  115.      relationships connected at the disk drive level versus smaller packages
  116.      which do most of their inter-relationships at runtime in memory, DBS-KAT
  117.      does not use up hardly any more disk space, and that is because of its
  118.      efficient use of disk space.  Additionally, DBS-KAT has to allow for its
  119.      database pointers to expand up to 16 million records.  What this means is
  120.      that on the average, DBS-KAT uses up only 7 percent more space per
  121.      cataloged directory entry than does its competitors.
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.      DBS-KAT TECH REF MANUAL       Copyright 1986 R.H. Martin       P. 3
  135.  
  136.  
  137.      The other packages gain their processing efficiency by storing the entire
  138.      database in memory at run time.  That is why they can't get larger,
  139.      because they are constrained by available program data memory space.
  140.      Yet, without significantly sacrificing additional disk space, DBS-KAT
  141.      uses disk space to hold its pointers, and achieves comparable processing
  142.      efficiency on a catalog database capable of holding 16 million records.
  143.  
  144.      The author maintains for himself a DBS-KAT database of over 12,800
  145.      filenames and around six hundred diskettes.
  146.  
  147.      Throughout the built-up of this database, the author has not noticed a
  148.      worsening of processing performance, except that a display request for a
  149.      floating substring phrase within any and all cataloged filenames does
  150.      take a little longer as the database grows.  To use the DOS DIR command
  151.      syntax to explain this type of search request, although DOS does not
  152.      honor such a search request, if it did, a request might look like this:
  153.      DIR *CAT*.  On a COMPAQ PLUS, with 8,000 filenames in a DBS-KAT database,
  154.      it takes under 2 minutes for such a search to finish, whereas with 6,000
  155.      filenames, it takes under 1.5 minutes.  Search requests for left-hand
  156.      anchored substring phrases within any and all cataloged filenames is
  157.      extremely rapid, taking only a couple of seconds to fulfill.  A search
  158.      request at the DOS DIR level might look like: DIR CAT*.
  159.  
  160.      DBS-KAT is fast because of the tools used in developing DBS-KAT
  161.      (discussed earlier) and because of its streamlined design.  For instance,
  162.      if you have a diskette previously cataloged by DBS-KAT, when you change,
  163.      add or delete a few files on the diskette, DBS-KAT concentrates on these
  164.      modifications.  A less efficient design might start out the processing of
  165.      each diskette with the deletion of all prior database information for
  166.      that diskette.  Because of DBS-KAT's usage of the sophisticated DB-VISTA
  167.      database manager, it is able to immediately access prior information for
  168.      the at-hand diskette in the correct processing order in which it needs
  169.      it.  Finally, DBS-KAT is fast because it allows the user to use a RAM
  170.      disk emulator to store the subprograms and work files for DBS-KAT on the
  171.      RAM disk.
  172.  
  173.      DBS-KAT is also fast because it is smart.  If you mistakenly insert a
  174.      diskette which hasn't changed since it was last processed by DBS-KAT, you
  175.      are told this is the case.  DBS-KAT keeps for each diskette both a
  176.      numeric total of the number of files on the diskette plus the sum of all
  177.      dates + all times + all file sizes of all the files on the diskette.
  178.      Before DBS-KAT considers updating directory entries for a diskette, it
  179.      compares these two new totals with the prior run's old totals.
  180.  
  181.  
  182.                          DBS-KAT INQUIRY SEARCH STRATEGIES
  183.  
  184.      To understand the many ways you can search your DBS-KAT database and how
  185.      efficient will be your search, you need to know how your DBS-KAT database
  186.      is structured.  For searching purposes, you can think of the database
  187.      being ordered in two different ways:
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.      DBS-KAT TECH REF MANUAL       Copyright 1986 R.H. Martin       P. 4
  201.  
  202.  
  203.      (a) by alphabetical, indexed, order by FILENAME.EXT, regardless of the
  204.          volume ID; and
  205.      (b) by numeric, indexed, order by volume ID, and within volume ID order,
  206.          subordered alphabetically, by FILENAME.EXT.
  207.  
  208.      The path information is carried in the database, but it has no ordering
  209.      effect in terms of aiding retrieval of information.
  210.  
  211.      Based upon the structure of DBS-KAT's database design, the following
  212.      examples represent a range of searchs ordered by a most efficient search
  213.      argument to a least efficient search argument:
  214.  
  215.          FILENAME ARGUMENT TYPE   EXT ARGUMENT TYPE   PATH ARGUMENT TYPE
  216.          --------          -      ---          -      --------      -
  217.          MYFILE            E      DOC          E      MYPATH        E
  218.          MYFILE            E      DOC          E      MY            A
  219.          MYFILE            E      DOC          E      AT            U
  220.          MYFILE            E      D            A      <left blank>
  221.          MYFILE            E      O            U      <left blank>
  222.          MYFILE            E      <left blank>        <left blank>
  223.          MY                A      DOC          E      MYPATH        E
  224.          MY                A      DOC          E      MY            A
  225.          MY                A      DOC          E      AT            U
  226.          MY                A      D            A      <left blank>
  227.          MY                A      O            U      <left blank>
  228.          MY                A      <left blank>        <left blank>
  229.          FIL               U      DOC          E      MYPATH        E
  230.          FIL               U      DOC          E      MY            A
  231.          FIL               U      DOC          E      AT            U
  232.          FIL               U      D            A      <left blank>
  233.          FIL               U      O            U      <left blank>
  234.        * FIL               U      <left blank>        <left blank>
  235.          <left blank>             DOC          E      MYPATH        E
  236.          <left blank>             DOC          E      MY            A
  237.          <left blank>             DOC          E      AT            U
  238.          <left blank>             D            A      <left blank>
  239.          <left blank>             O            U      <left blank>
  240.          <left blank>             <left blank>        MYPATH        E
  241.          <left blank>             <left blank>        MY            A
  242.          <left blank>             <left blank>        AT            U
  243.  
  244.      Don't be afraid to use the search strategy you need to accomplish the job
  245.      you want done.  For instance, against a database of 12,000 directory
  246.      entries, to search using an argument like the above line with an asterick
  247.      preceeding it, took around two and a half minutes.  This search argument
  248.      causes the entire database to be scanned from start to end.
  249.  
  250.  
  251.                              RECOVERING YOUR DATABASE
  252.  
  253.      "Into each life a little rain must fall."  It can happen to one's
  254.      database too.  Recovery should be done when you loose your hard disk or
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.      DBS-KAT TECH REF MANUAL       Copyright 1986 R.H. Martin       P. 5
  267.  
  268.  
  269.      when something has damaged your database.  In either case, the database
  270.      recovery procedure is the same.  True, you have to restore everything
  271.      else in a hard disk failure, but you're on your own to figure that
  272.      dilemna out.  Just the database recovery procedure is documented here.
  273.      Follow these procedures.
  274.  
  275.      #   ACTION  EVENT OR COMMAND                      COMMENT
  276.      --  ------  ----------------------------------    -----------------------
  277.      1   Type    C:                                    Move to your hard disk.
  278.  
  279.      2   Type    CD \                                  Move to the root
  280.                                                        directory.
  281.  
  282.      3   Type    VERIFY ON                             Ensure better file
  283.                                                        copies.
  284.  
  285.      4   Type    COPY KATDB.LOG KATDB.FIX              Save current log file.
  286.  
  287.      5   Type    KATLOG                                Print your current log
  288.                                                        file.
  289.  
  290.      6   Find    Latest DBS-KAT database backup disks  Insert disk 1 into
  291.                                                        drive.
  292.  
  293.      7   Type    RESTORE A: C:KATDB.*                  Restore old DBS-KAT
  294.                                                        database.
  295.  
  296.      8   Do      DBS-KAT Integrity Analysis if not     If integrity fails go
  297.                  using a "VERIFIED" backup set.        back to step 5.
  298.  
  299.      9   Read    KATLOG printout for line # of B/U state which you're restored
  300.                  to.  Call this number "RESTORE-LINENUM".
  301.  
  302.      10  Read    KATLOG printout for last line # of printout.  Call this
  303.                  number "LAST-LINENUM".
  304.  
  305.      11  Calc    Write down what LAST-LINENUM minus RESTORE-LINENUM equals.
  306.                  Call this number STRIP-LINENUM.
  307.  
  308.      12  Type    KATSTRIP STRIP-LINENUM                Substitute real number.
  309.                                                        KATDB.FIX now contains
  310.                                                        an unsorted list of
  311.                                                        disks to reprocess.
  312.  
  313.      13  Type    SORT <KATDB.FIX >PRN                  This printout is sorted
  314.                                                        by yet-to-redo volume
  315.                                                        ID within location.
  316.  
  317.      14  DO      KAT -U or some variation              Reprocess listed
  318.                                                        diskettes.
  319.  
  320.      15  Type    DEL KATDB.FIX                         No longer needed.
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.      DBS-KAT TECH REF MANUAL       Copyright 1986 R.H. Martin       P. 6
  333.  
  334.  
  335.  
  336.      You're done!  Consider doing a DBS-KAT Integrity Analysis and Backup to
  337.      preserve the recovery work you just went through.
  338.  
  339.  
  340.                               DBS-KAT VERSION HISTORY
  341.  
  342.      REL.  CATEGORY CHG.  WHEN  COMMENT-------------------------------------
  343.  
  344.      1.0   BETA RELEASE   6/85  Not released to general public.
  345.      1.1   BETA UPDATE    6/85  " ".
  346.      1.2   PUBLIC REL.    1/86  First public release under PC-KAT name.
  347.      1.2A  RARE BUG FIX   1/86  If diskette had multiple directories on it,
  348.                                 1.2 occassionally would abort.
  349.      1.2B  RARE BUG FIX   1/86  Improvement upon 1.2A fix; changing all
  350.                                 copyright statements to 1986 year.
  351.      1.2C  COSMETIC FIX   2/86  KATLOOK handled printer formfeed wrong when
  352.                                 doing multi-page volume header subselection
  353.                                 retrieval; added version history notes;
  354.                                 shortened novice install instructions.
  355.      1.3   NAME CHANGE    2/86  Product renamed DBS-KAT.
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.